pp108 : GetObjectsByTemplate (Deprecated)

GetObjectsByTemplate (Deprecated)


This method is used to retrieve all the objects that belong to a particular template. GetObjectsByTemplate is part of the CoBOC Methodset 4.2 in the Cordys CoBOC application package.

SOAP Request

<GetObjectsByTemplate xmlns="http://schemas.cordys.com/4.2/coboc">
    <cursor numRows="4"/>
    <template_name>/Vendor/Product</template_name>
    <template_id>88a2aa8c-0ac0-44ac-0084-aa02a87711e5</template_id>
    <version>user</version>
    <order_by>DIRECTORY.Prod</order_by>
    <order>ASC</order>
</GetObjectsByTemplate>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

cursor

Number of rows to be returned by the query

String

The numRows attribute of this element determines the number of rows that would be returned by the query

template_name

Name of the template

String

template_id

ID of the template

String

version

Contains the version of the type of content

String

The supported versions are:

  • user
  • organization
  • isv
    If you do not provide the version, the system first searches in the user space, followed by the organization space, and then in the isv space.

order_by

The field on which the objects are to be sorted.

String

Provide the column name of the CoBOC database on which you want to sort.For eg: DIRECTORY.ENTITY_NAME will sort based on the entity_name column in the directory table.

order

The sort order in which the objects are to be displayed.

String

ASC - objects are sorted in ascending order(default).DESC- objects are sorted in descending order

SOAP Response

<GetObjectsByTemplateResponse
    xmlns="http://schemas.cordys.com/4.2/coboc" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <cursor id="1.160" maxRows="99999995" numRows="4" position="4"/>
    <tuple>
        <old>
            <data>
                <metadata>
                    <object_id>88a35264-0ac0-44ac-0084-aa02f26f3302</object_id>
                    <folder_id>88a1f5f3-0ac0-44ac-0084-aa02c9613709</folder_id>
                    <objectname>Prod1</objectname>
                    <key>/Vendor/Prod1</key>
                    <organization>o=system,cn=cordys,o=vanenburg.com</organization>
                    <owner>cn=JDoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</owner>
                    <description/>
                    <customkey>88a35264-0ac0-44ac-0084-aa02f26f3302</customkey>
                    <history>0</history>
                    <event>0</event>
                    <template_id>88a2aa8c-0ac0-44ac-0084-aa02a87711e5</template_id>
                    <lastmodifieddate>1191998345828</lastmodifieddate>
                </metadata>
                <object>
                    <Product xmlns="">
                        <Id>101</Id>
                        <Name>John</Name>
                    </Product>
                </object>
            </data>
        </old>
    </tuple>
    <tuple>
        <old>
            <data>
                <metadata>
                    <object_id>88a3ffe9-0ac0-44ac-0084-aa023d7870a9</object_id>
                    <folder_id>88a1f5f3-0ac0-44ac-0084-aa02c9613709</folder_id>
                    <objectname>Prod2</objectname>
                    <key>/Vendor/Prod2</key>
                    <organization>o=system,cn=cordys,o=vanenburg.com</organization>
                    <owner>cn=JDoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</owner>
                    <description/>
                    <customkey>88a3ffe9-0ac0-44ac-0084-aa023d7870a9</customkey>
                    <history>0</history>
                    <event>0</event>
                    <template_id>88a2aa8c-0ac0-44ac-0084-aa02a87711e5</template_id>
                    <lastmodifieddate>1191998390249</lastmodifieddate>
                </metadata>
                <object>
                    <Product xmlns="">
                        <Id>102</Id>
                        <Name>Abe</Name>
                    </Product>
                </object>
            </data>
        </old>
    </tuple>
    <tuple>
        <old>
            <data>
                <metadata>
                    <object_id>8984aef9-0ac0-44ac-0084-aa021c34078f</object_id>
                    <folder_id>88a1f5f3-0ac0-44ac-0084-aa02c9613709</folder_id>
                    <objectname>Prod3</objectname>
                    <key>/Vendor/Prod3</key>
                    <organization>o=system,cn=cordys,o=vanenburg.com</organization>
                    <owner>cn=JDoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</owner>
                    <description/>
                    <customkey>8984aef9-0ac0-44ac-0084-aa021c34078f</customkey>
                    <history>0</history>
                    <event>0</event>
                    <template_id>88a2aa8c-0ac0-44ac-0084-aa02a87711e5</template_id>
                    <lastmodifieddate>1192013115129</lastmodifieddate>
                </metadata>
                <object>
                    <Product xmlns="">
                        <Id>103</Id>
                        <Name>Kathy</Name>
                    </Product>
                </object>
            </data>
        </old>
    </tuple>
</GetObjectsByTemplateResponse>

Response Parameters

Parameter

Description

old

Indicates that the object contained in the request exists in the database

object_id

Unique ID identifying the object

folder_id

Unique ID identifying the folder

objectname

Name of the object

key

Name of the object along with the full path

organization

Organization in which the object has been inserted

owner

User who instantiated the object

description

Description of the object

customkey

Custom key of the object. Defined on an attribute of a template, the custom key prevents replication of the object and maintains object uniqueness.

history

Indicates whether the object is being monitored

event

Information about events defined on the object. Events help track changes in the state of the object.

template_id

Unique ID identifying the template

lastmodifieddate

Indicates the last date and time of modification of the object

object

Inserted object enclosed within this element.